package com.zdpx.pxframework.system.api;

import com.zdpx.pxframework.core.vo.PageResult;
import com.zdpx.pxframework.core.vo.Result;
import com.zdpx.pxframework.system.entity.UserRole;
import com.zdpx.pxframework.system.vo.query.UserRoleQuery;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

import java.util.List;


/**
 * 用户角色关联 接口Swagger Api
 *
 * @Description:
 * @Author: Cheng XiaoXiao
 * @Date: 2022-02-27 15:20:14
 */
@Api(tags = "用户角色关联模块", description = "实现对用户角色关联数据的基本操作")
public interface UserRoleControllerApi {


    /**
     * 按照条件查询用户角色关联信息
     *
     * @param userRoleQuery 查询条件
     * @return 结果信息
     */
    @ApiOperation(value = "按照条件查询用户角色关联信息")
    Result<List<UserRole>> list(UserRoleQuery userRoleQuery);

    /**
     * 分页及条件查询用户角色关联信息
     *
     * @param page          页码
     * @param size          分页大小
     * @param userRoleQuery 查询条件
     * @return 分页结果信息
     */
    @ApiOperation(value = "分页及条件查询用户角色关联信息")
    Result<PageResult<UserRole>> search(@ApiParam(name = "page", value = "当前页", required = true, type = "path") Long page,
                                        @ApiParam(name = "size", value = "页码大小", required = true, type = "path") Long size,
                                        UserRoleQuery userRoleQuery);

    /**
     * 根据ID获取用户角色关联详情
     *
     * @param id 用户角色关联ID
     * @return 用户角色关联详细信息
     */
    @ApiOperation(value = "获取单个用户角色关联详情")
    @ApiParam(name = "id", value = "用户角色关联ID", required = true, type = "path")
    Result<UserRole> detail(String id);

    /**
     * 增加用户角色关联信息
     *
     * @param userRole 用户角色关联增加实体
     * @return 增加后的用户角色关联信息
     */
    @ApiOperation(value = "增加用户角色关联信息")
    Result<UserRole> add(UserRole userRole);

    /**
     * 修改用户角色关联信息
     *
     * @param id       用户角色关联ID
     * @param userRole 用户角色关联修改实体
     * @return 修改后的用户角色关联信息
     */
    @ApiOperation(value = "修改用户角色关联信息")
    Result<UserRole> updateById(@ApiParam(name = "id", value = "用户角色关联ID", type = "path") String id, UserRole userRole);

    /**
     * 删除用户角色关联信息
     *
     * @param id 用户角色关联ID
     * @return 删除结果信息
     */
    @ApiOperation(value = "删除单个用户角色关联信息")
    Result<Boolean> deleteById(@ApiParam(name = "id", value = "用户角色关联ID", type = "path") String id);

    /**
     * 删除用户角色关联信息
     *
     * @param idList 用户角色关联ID数组
     * @return 删除结果信息
     */
    @ApiOperation(value = "批量删除用户角色关联信息")
    Result<Boolean> batchRemove(List<String> idList);

}
